<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sditxss: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sditxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__sditxss.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga947c864c39e22328573d30b2cd0f4ca3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sditxss.html#ga947c864c39e22328573d30b2cd0f4ca3">XV_SdiTxSs_SubcoreInitSdiTx</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *SdiTxSsPtr)</td></tr>
<tr class="memdesc:ga947c864c39e22328573d30b2cd0f4ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the included sub-core to it's static configuration.  <a href="#ga947c864c39e22328573d30b2cd0f4ca3">More...</a><br/></td></tr>
<tr class="separator:ga947c864c39e22328573d30b2cd0f4ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga014e94de29a924cc95a2282fe8abf748"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sditxss.html#ga014e94de29a924cc95a2282fe8abf748">XV_SdiTxSs_SubcoreInitVtc</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *SdiTxSsPtr)</td></tr>
<tr class="memdesc:ga014e94de29a924cc95a2282fe8abf748"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the included sub-core to it's static configuration.  <a href="#ga014e94de29a924cc95a2282fe8abf748">More...</a><br/></td></tr>
<tr class="separator:ga014e94de29a924cc95a2282fe8abf748"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73c36b96c1df65a8fa2727ecaf4bb647"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sditxss.html#ga73c36b96c1df65a8fa2727ecaf4bb647">XV_SdiTxSs_SelfTest</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga73c36b96c1df65a8fa2727ecaf4bb647"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs self test on SDI Tx Subsystem sub-cores.  <a href="#ga73c36b96c1df65a8fa2727ecaf4bb647">More...</a><br/></td></tr>
<tr class="separator:ga73c36b96c1df65a8fa2727ecaf4bb647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b21d762f221a77fcb9b345149c7cd78"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sditxss.html#ga2b21d762f221a77fcb9b345149c7cd78">SdiTxSs_SelfTestExample</a> (u32 DeviceId)</td></tr>
<tr class="memdesc:ga2b21d762f221a77fcb9b345149c7cd78"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the main entry point for the self test example using the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> driver.  <a href="#ga2b21d762f221a77fcb9b345149c7cd78">More...</a><br/></td></tr>
<tr class="separator:ga2b21d762f221a77fcb9b345149c7cd78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sditxss.html#ga840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:ga840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main function for <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> self test example.  <a href="#ga840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the main function for <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> self test example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the self test example passed.</li>
<li>XST_FAILURE if the self test example was unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__v__sditxss.html#ga2b21d762f221a77fcb9b345149c7cd78">SdiTxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2b21d762f221a77fcb9b345149c7cd78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 SdiTxSs_SelfTestExample </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the main entry point for the self test example using the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> driver. </p>
<p>This function check whether or not its sub-core drivers self test functions are in working state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the SDI TX Subsystem core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if any of SDI TX Subsystem sub-core self test failed.</li>
<li>XST_SUCCESS, if all of SDI TX Subsystem sub-core self test passed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___config.html#ac217e83b31add4264129e7350e1c90ed">XV_SdiTxSs_Config::BaseAddress</a>, <a class="el" href="xv__sditxss_8c.html#a4bdb55bb1af5300e000e420e35256eb8">XV_SdiTxSs_CfgInitialize()</a>, <a class="el" href="xv__sditxss_8h.html#a5fe4829ee3a2e6d471f77b4cf69c8c0f">XV_SdiTxSs_LookupConfig()</a>, and <a class="el" href="group__v__sditxss.html#ga73c36b96c1df65a8fa2727ecaf4bb647">XV_SdiTxSs_SelfTest()</a>.</p>

<p>Referenced by <a class="el" href="group__v__sditxss.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga73c36b96c1df65a8fa2727ecaf4bb647"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XV_SdiTxSs_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function performs self test on SDI Tx Subsystem sub-cores. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if self test passed.</li>
<li>XST_FAILURE if self test failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss.html#a2499b55a82ee0938a2d0fcdca1077d71">XV_SdiTxSs::SdiTxPtr</a>.</p>

<p>Referenced by <a class="el" href="group__v__sditxss.html#ga2b21d762f221a77fcb9b345149c7cd78">SdiTxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga947c864c39e22328573d30b2cd0f4ca3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_SdiTxSs_SubcoreInitSdiTx </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>SdiTxSsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the included sub-core to it's static configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">SdiTxSsPtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS/XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___sub_core.html#a07529e836de5974edc4ec084e9d4677d">XV_SdiTxSs_SubCore::AbsAddr</a>, <a class="el" href="struct_x_v___sdi_tx_ss___config.html#ac217e83b31add4264129e7350e1c90ed">XV_SdiTxSs_Config::BaseAddress</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#af7d89922bc62fa37fbd2bb092e4d313a">XV_SdiTxSs::Config</a>, <a class="el" href="struct_x_v___sdi_tx_ss___sub_core.html#a58147b83f1cbcc053f288b0770ce5d4f">XV_SdiTxSs_SubCore::DeviceId</a>, <a class="el" href="struct_x_v___sdi_tx_ss___config.html#aaf6f2c5fe1b6586f655957735539e72e">XV_SdiTxSs_Config::SdiTx</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#a2499b55a82ee0938a2d0fcdca1077d71">XV_SdiTxSs::SdiTxPtr</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553ae22f2169dcf22ddb067ac470c4c3ea28">XV_SDITXSS_LOG_EVT_SDITX_INIT</a>, and <a class="el" href="xv__sditxss_8h.html#a986a5881e775194f864ebaa1f055afa6">XV_SdiTxSs_LogWrite()</a>.</p>

<p>Referenced by <a class="el" href="xv__sditxss_8h.html#a4bdb55bb1af5300e000e420e35256eb8">XV_SdiTxSs_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga014e94de29a924cc95a2282fe8abf748"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_SdiTxSs_SubcoreInitVtc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>SdiTxSsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the included sub-core to it's static configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">SdiTxSsPtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS/XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___sub_core.html#a07529e836de5974edc4ec084e9d4677d">XV_SdiTxSs_SubCore::AbsAddr</a>, <a class="el" href="struct_x_v___sdi_tx_ss___config.html#ac217e83b31add4264129e7350e1c90ed">XV_SdiTxSs_Config::BaseAddress</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#af7d89922bc62fa37fbd2bb092e4d313a">XV_SdiTxSs::Config</a>, <a class="el" href="struct_x_v___sdi_tx_ss___sub_core.html#a58147b83f1cbcc053f288b0770ce5d4f">XV_SdiTxSs_SubCore::DeviceId</a>, <a class="el" href="struct_x_v___sdi_tx_ss___config.html#ad3bfb31c9e8cad01223a2d39080bf2d5">XV_SdiTxSs_Config::Vtc</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#a8b4c009d37093d905ec9ddc0675e4d87">XV_SdiTxSs::VtcPtr</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553afc8392e1e0ed781f3a833f6a2b292c3c">XV_SDITXSS_LOG_EVT_VTC_INIT</a>, and <a class="el" href="xv__sditxss_8h.html#a986a5881e775194f864ebaa1f055afa6">XV_SdiTxSs_LogWrite()</a>.</p>

<p>Referenced by <a class="el" href="xv__sditxss_8h.html#a4bdb55bb1af5300e000e420e35256eb8">XV_SdiTxSs_CfgInitialize()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
